<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>DocumentHelper xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/dom4j/DocumentHelper.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="3" href="#3">3</a>   <em class="comment"> *</em>
<a name="4" href="#4">4</a>   <em class="comment"> * This software is open source.</em>
<a name="5" href="#5">5</a>   <em class="comment"> * See the bottom of this file for the licence.</em>
<a name="6" href="#6">6</a>   <em class="comment"> */</em>
<a name="7" href="#7">7</a>   
<a name="8" href="#8">8</a>   <strong>package</strong> <a href="../../org/dom4j/package-summary.html">org.dom4j</a>;
<a name="9" href="#9">9</a>   
<a name="10" href="#10">10</a>  <strong>import</strong> java.io.StringReader;
<a name="11" href="#11">11</a>  <strong>import</strong> java.util.List;
<a name="12" href="#12">12</a>  <strong>import</strong> java.util.Map;
<a name="13" href="#13">13</a>  <strong>import</strong> java.util.StringTokenizer;
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>import</strong> org.dom4j.io.SAXReader;
<a name="16" href="#16">16</a>  <strong>import</strong> org.dom4j.rule.Pattern;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong>import</strong> org.jaxen.VariableContext;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong>import</strong> org.xml.sax.InputSource;
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <em>/**<em>*</em></em>
<a name="23" href="#23">23</a>  <em> * &lt;p></em>
<a name="24" href="#24">24</a>  <em> * &lt;code>DocumentHelper&lt;/code> is a collection of helper methods for using</em>
<a name="25" href="#25">25</a>  <em> * DOM4J.</em>
<a name="26" href="#26">26</a>  <em> * &lt;/p></em>
<a name="27" href="#27">27</a>  <em> * </em>
<a name="28" href="#28">28</a>  <em> * @author &lt;a href="<a href="mailto:jstrachan@apache.org" target="alexandria_uri">mailto:jstrachan@apache.org</a>">James Strachan &lt;/a></em>
<a name="29" href="#29">29</a>  <em> * @version $Revision: 1.26 $</em>
<a name="30" href="#30">30</a>  <em> */</em>
<a name="31" href="#31">31</a>  <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../org/dom4j/DocumentHelper.html">DocumentHelper</a> {
<a name="32" href="#32">32</a>      <strong>private</strong> <a href="../../org/dom4j/DocumentHelper.html">DocumentHelper</a>() {
<a name="33" href="#33">33</a>      }
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>      <strong>private</strong> <strong>static</strong> <a href="../../org/dom4j/DocumentFactory.html">DocumentFactory</a> getDocumentFactory() {
<a name="36" href="#36">36</a>          <strong>return</strong> DocumentFactory.getInstance();
<a name="37" href="#37">37</a>      }
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>      <em class="comment">// Static helper methods</em>
<a name="40" href="#40">40</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Document.html">Document</a> createDocument() {
<a name="41" href="#41">41</a>          <strong>return</strong> getDocumentFactory().createDocument();
<a name="42" href="#42">42</a>      }
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Document.html">Document</a> createDocument(<a href="../../org/dom4j/Element.html">Element</a> rootElement) {
<a name="45" href="#45">45</a>          <strong>return</strong> getDocumentFactory().createDocument(rootElement);
<a name="46" href="#46">46</a>      }
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Element.html">Element</a> createElement(<a href="../../org/dom4j/QName.html">QName</a> qname) {
<a name="49" href="#49">49</a>          <strong>return</strong> getDocumentFactory().createElement(qname);
<a name="50" href="#50">50</a>      }
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Element.html">Element</a> createElement(String name) {
<a name="53" href="#53">53</a>          <strong>return</strong> getDocumentFactory().createElement(name);
<a name="54" href="#54">54</a>      }
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Attribute.html">Attribute</a> createAttribute(<a href="../../org/dom4j/Element.html">Element</a> owner, <a href="../../org/dom4j/QName.html">QName</a> qname,
<a name="57" href="#57">57</a>              String value) {
<a name="58" href="#58">58</a>          <strong>return</strong> getDocumentFactory().createAttribute(owner, qname, value);
<a name="59" href="#59">59</a>      }
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Attribute.html">Attribute</a> createAttribute(<a href="../../org/dom4j/Element.html">Element</a> owner, String name,
<a name="62" href="#62">62</a>              String value) {
<a name="63" href="#63">63</a>          <strong>return</strong> getDocumentFactory().createAttribute(owner, name, value);
<a name="64" href="#64">64</a>      }
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/CDATA.html">CDATA</a> createCDATA(String text) {
<a name="67" href="#67">67</a>          <strong>return</strong> DocumentFactory.getInstance().createCDATA(text);
<a name="68" href="#68">68</a>      }
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Comment.html">Comment</a> createComment(String text) {
<a name="71" href="#71">71</a>          <strong>return</strong> DocumentFactory.getInstance().createComment(text);
<a name="72" href="#72">72</a>      }
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Text.html">Text</a> createText(String text) {
<a name="75" href="#75">75</a>          <strong>return</strong> DocumentFactory.getInstance().createText(text);
<a name="76" href="#76">76</a>      }
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Entity.html">Entity</a> createEntity(String name, String text) {
<a name="79" href="#79">79</a>          <strong>return</strong> DocumentFactory.getInstance().createEntity(name, text);
<a name="80" href="#80">80</a>      }
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Namespace.html">Namespace</a> createNamespace(String prefix, String uri) {
<a name="83" href="#83">83</a>          <strong>return</strong> DocumentFactory.getInstance().createNamespace(prefix, uri);
<a name="84" href="#84">84</a>      }
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/ProcessingInstruction.html">ProcessingInstruction</a> createProcessingInstruction(String pi,
<a name="87" href="#87">87</a>              String d) {
<a name="88" href="#88">88</a>          <strong>return</strong> getDocumentFactory().createProcessingInstruction(pi, d);
<a name="89" href="#89">89</a>      }
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/ProcessingInstruction.html">ProcessingInstruction</a> createProcessingInstruction(String pi,
<a name="92" href="#92">92</a>              Map data) {
<a name="93" href="#93">93</a>          <strong>return</strong> getDocumentFactory().createProcessingInstruction(pi, data);
<a name="94" href="#94">94</a>      }
<a name="95" href="#95">95</a>  
<a name="96" href="#96">96</a>      <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/QName.html">QName</a> createQName(String localName, <a href="../../org/dom4j/Namespace.html">Namespace</a> namespace) {
<a name="97" href="#97">97</a>          <strong>return</strong> getDocumentFactory().createQName(localName, namespace);
<a name="98" href="#98">98</a>      }
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/QName.html">QName</a> createQName(String localName) {
<a name="101" href="#101">101</a>         <strong>return</strong> getDocumentFactory().createQName(localName);
<a name="102" href="#102">102</a>     }
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>     <em>/**<em>*</em></em>
<a name="105" href="#105">105</a> <em>     * &lt;p></em>
<a name="106" href="#106">106</a> <em>     * &lt;code>createXPath&lt;/code> parses an XPath expression and creates a new</em>
<a name="107" href="#107">107</a> <em>     * XPath &lt;code>XPath&lt;/code> instance using the singleton {@link</em>
<a name="108" href="#108">108</a> <em>     * DocumentFactory}.</em>
<a name="109" href="#109">109</a> <em>     * &lt;/p></em>
<a name="110" href="#110">110</a> <em>     * </em>
<a name="111" href="#111">111</a> <em>     * @param xpathExpression</em>
<a name="112" href="#112">112</a> <em>     *            is the XPath expression to create</em>
<a name="113" href="#113">113</a> <em>     * </em>
<a name="114" href="#114">114</a> <em>     * @return a new &lt;code>XPath&lt;/code> instance</em>
<a name="115" href="#115">115</a> <em>     * </em>
<a name="116" href="#116">116</a> <em>     * @throws InvalidXPathException</em>
<a name="117" href="#117">117</a> <em>     *             if the XPath expression is invalid</em>
<a name="118" href="#118">118</a> <em>     */</em>
<a name="119" href="#119">119</a>     <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/XPath.html">XPath</a> createXPath(String xpathExpression)
<a name="120" href="#120">120</a>             throws <a href="../../org/dom4j/InvalidXPathException.html">InvalidXPathException</a> {
<a name="121" href="#121">121</a>         <strong>return</strong> getDocumentFactory().createXPath(xpathExpression);
<a name="122" href="#122">122</a>     }
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>     <em>/**<em>*</em></em>
<a name="125" href="#125">125</a> <em>     * &lt;p></em>
<a name="126" href="#126">126</a> <em>     * &lt;code>createXPath&lt;/code> parses an XPath expression and creates a new</em>
<a name="127" href="#127">127</a> <em>     * XPath &lt;code>XPath&lt;/code> instance using the singleton {@link</em>
<a name="128" href="#128">128</a> <em>     * DocumentFactory}.</em>
<a name="129" href="#129">129</a> <em>     * &lt;/p></em>
<a name="130" href="#130">130</a> <em>     * </em>
<a name="131" href="#131">131</a> <em>     * @param xpathExpression</em>
<a name="132" href="#132">132</a> <em>     *            is the XPath expression to create</em>
<a name="133" href="#133">133</a> <em>     * @param context</em>
<a name="134" href="#134">134</a> <em>     *            is the variable context to use when evaluating the XPath</em>
<a name="135" href="#135">135</a> <em>     * </em>
<a name="136" href="#136">136</a> <em>     * @return a new &lt;code>XPath&lt;/code> instance</em>
<a name="137" href="#137">137</a> <em>     * </em>
<a name="138" href="#138">138</a> <em>     * @throws InvalidXPathException</em>
<a name="139" href="#139">139</a> <em>     *             if the XPath expression is invalid</em>
<a name="140" href="#140">140</a> <em>     */</em>
<a name="141" href="#141">141</a>     <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/XPath.html">XPath</a> createXPath(String xpathExpression,
<a name="142" href="#142">142</a>             VariableContext context) throws InvalidXPathException {
<a name="143" href="#143">143</a>         <strong>return</strong> getDocumentFactory().createXPath(xpathExpression, context);
<a name="144" href="#144">144</a>     }
<a name="145" href="#145">145</a> 
<a name="146" href="#146">146</a>     <em>/**<em>*</em></em>
<a name="147" href="#147">147</a> <em>     * &lt;p></em>
<a name="148" href="#148">148</a> <em>     * &lt;code>createXPathFilter&lt;/code> parses a NodeFilter from the given XPath</em>
<a name="149" href="#149">149</a> <em>     * filter expression using the singleton {@link DocumentFactory}. XPath</em>
<a name="150" href="#150">150</a> <em>     * filter expressions occur within XPath expressions such as</em>
<a name="151" href="#151">151</a> <em>     * &lt;code>self::node()[ filterExpression ]&lt;/code></em>
<a name="152" href="#152">152</a> <em>     * &lt;/p></em>
<a name="153" href="#153">153</a> <em>     * </em>
<a name="154" href="#154">154</a> <em>     * @param xpathFilterExpression</em>
<a name="155" href="#155">155</a> <em>     *            is the XPath filter expression to create</em>
<a name="156" href="#156">156</a> <em>     * </em>
<a name="157" href="#157">157</a> <em>     * @return a new &lt;code>NodeFilter&lt;/code> instance</em>
<a name="158" href="#158">158</a> <em>     */</em>
<a name="159" href="#159">159</a>     <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/NodeFilter.html">NodeFilter</a> createXPathFilter(String xpathFilterExpression) {
<a name="160" href="#160">160</a>         <strong>return</strong> getDocumentFactory().createXPathFilter(xpathFilterExpression);
<a name="161" href="#161">161</a>     }
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em>/**<em>*</em></em>
<a name="164" href="#164">164</a> <em>     * &lt;p></em>
<a name="165" href="#165">165</a> <em>     * &lt;code>createPattern&lt;/code> parses the given XPath expression to create</em>
<a name="166" href="#166">166</a> <em>     * an XSLT style {@link Pattern}instance which can then be used in an XSLT</em>
<a name="167" href="#167">167</a> <em>     * processing model.</em>
<a name="168" href="#168">168</a> <em>     * &lt;/p></em>
<a name="169" href="#169">169</a> <em>     * </em>
<a name="170" href="#170">170</a> <em>     * @param xpathPattern</em>
<a name="171" href="#171">171</a> <em>     *            is the XPath pattern expression to create</em>
<a name="172" href="#172">172</a> <em>     * </em>
<a name="173" href="#173">173</a> <em>     * @return a new &lt;code>Pattern&lt;/code> instance</em>
<a name="174" href="#174">174</a> <em>     */</em>
<a name="175" href="#175">175</a>     <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/rule/Pattern.html">Pattern</a> createPattern(String xpathPattern) {
<a name="176" href="#176">176</a>         <strong>return</strong> getDocumentFactory().createPattern(xpathPattern);
<a name="177" href="#177">177</a>     }
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a>     <em>/**<em>*</em></em>
<a name="180" href="#180">180</a> <em>     * &lt;p></em>
<a name="181" href="#181">181</a> <em>     * &lt;code>selectNodes&lt;/code> performs the given XPath expression on the</em>
<a name="182" href="#182">182</a> <em>     * {@link List}of {@link Node}instances appending all the results together</em>
<a name="183" href="#183">183</a> <em>     * into a single list.</em>
<a name="184" href="#184">184</a> <em>     * &lt;/p></em>
<a name="185" href="#185">185</a> <em>     * </em>
<a name="186" href="#186">186</a> <em>     * @param xpathFilterExpression</em>
<a name="187" href="#187">187</a> <em>     *            is the XPath filter expression to evaluate</em>
<a name="188" href="#188">188</a> <em>     * @param nodes</em>
<a name="189" href="#189">189</a> <em>     *            is the list of nodes on which to evalute the XPath</em>
<a name="190" href="#190">190</a> <em>     * </em>
<a name="191" href="#191">191</a> <em>     * @return the results of all the XPath evaluations as a single list</em>
<a name="192" href="#192">192</a> <em>     */</em>
<a name="193" href="#193">193</a>     <strong>public</strong> <strong>static</strong> List selectNodes(String xpathFilterExpression, List nodes) {
<a name="194" href="#194">194</a>         <a href="../../org/dom4j/XPath.html">XPath</a> xpath = createXPath(xpathFilterExpression);
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>         <strong>return</strong> xpath.selectNodes(nodes);
<a name="197" href="#197">197</a>     }
<a name="198" href="#198">198</a> 
<a name="199" href="#199">199</a>     <em>/**<em>*</em></em>
<a name="200" href="#200">200</a> <em>     * &lt;p></em>
<a name="201" href="#201">201</a> <em>     * &lt;code>selectNodes&lt;/code> performs the given XPath expression on the</em>
<a name="202" href="#202">202</a> <em>     * {@link List}of {@link Node}instances appending all the results together</em>
<a name="203" href="#203">203</a> <em>     * into a single list.</em>
<a name="204" href="#204">204</a> <em>     * &lt;/p></em>
<a name="205" href="#205">205</a> <em>     * </em>
<a name="206" href="#206">206</a> <em>     * @param xpathFilterExpression</em>
<a name="207" href="#207">207</a> <em>     *            is the XPath filter expression to evaluate</em>
<a name="208" href="#208">208</a> <em>     * @param node</em>
<a name="209" href="#209">209</a> <em>     *            is the Node on which to evalute the XPath</em>
<a name="210" href="#210">210</a> <em>     * </em>
<a name="211" href="#211">211</a> <em>     * @return the results of all the XPath evaluations as a single list</em>
<a name="212" href="#212">212</a> <em>     */</em>
<a name="213" href="#213">213</a>     <strong>public</strong> <strong>static</strong> List selectNodes(String xpathFilterExpression, <a href="../../org/dom4j/Node.html">Node</a> node) {
<a name="214" href="#214">214</a>         <a href="../../org/dom4j/XPath.html">XPath</a> xpath = createXPath(xpathFilterExpression);
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>         <strong>return</strong> xpath.selectNodes(node);
<a name="217" href="#217">217</a>     }
<a name="218" href="#218">218</a> 
<a name="219" href="#219">219</a>     <em>/**<em>*</em></em>
<a name="220" href="#220">220</a> <em>     * &lt;p></em>
<a name="221" href="#221">221</a> <em>     * &lt;code>sort&lt;/code> sorts the given List of Nodes using an XPath</em>
<a name="222" href="#222">222</a> <em>     * expression as a {@link java.util.Comparator}.</em>
<a name="223" href="#223">223</a> <em>     * &lt;/p></em>
<a name="224" href="#224">224</a> <em>     * </em>
<a name="225" href="#225">225</a> <em>     * @param list</em>
<a name="226" href="#226">226</a> <em>     *            is the list of Nodes to sort</em>
<a name="227" href="#227">227</a> <em>     * @param xpathExpression</em>
<a name="228" href="#228">228</a> <em>     *            is the XPath expression used for comparison</em>
<a name="229" href="#229">229</a> <em>     */</em>
<a name="230" href="#230">230</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> sort(List list, String xpathExpression) {
<a name="231" href="#231">231</a>         <a href="../../org/dom4j/XPath.html">XPath</a> xpath = createXPath(xpathExpression);
<a name="232" href="#232">232</a>         xpath.sort(list);
<a name="233" href="#233">233</a>     }
<a name="234" href="#234">234</a> 
<a name="235" href="#235">235</a>     <em>/**<em>*</em></em>
<a name="236" href="#236">236</a> <em>     * &lt;p></em>
<a name="237" href="#237">237</a> <em>     * &lt;code>sort&lt;/code> sorts the given List of Nodes using an XPath</em>
<a name="238" href="#238">238</a> <em>     * expression as a {@link java.util.Comparator}and optionally removing</em>
<a name="239" href="#239">239</a> <em>     * duplicates.</em>
<a name="240" href="#240">240</a> <em>     * &lt;/p></em>
<a name="241" href="#241">241</a> <em>     * </em>
<a name="242" href="#242">242</a> <em>     * @param list</em>
<a name="243" href="#243">243</a> <em>     *            is the list of Nodes to sort</em>
<a name="244" href="#244">244</a> <em>     * @param expression</em>
<a name="245" href="#245">245</a> <em>     *            is the XPath expression used for comparison</em>
<a name="246" href="#246">246</a> <em>     * @param distinct</em>
<a name="247" href="#247">247</a> <em>     *            if true then duplicate values (using the sortXPath for</em>
<a name="248" href="#248">248</a> <em>     *            comparisions) will be removed from the List</em>
<a name="249" href="#249">249</a> <em>     */</em>
<a name="250" href="#250">250</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> sort(List list, String expression, <strong>boolean</strong> distinct) {
<a name="251" href="#251">251</a>         <a href="../../org/dom4j/XPath.html">XPath</a> xpath = createXPath(expression);
<a name="252" href="#252">252</a>         xpath.sort(list, distinct);
<a name="253" href="#253">253</a>     }
<a name="254" href="#254">254</a> 
<a name="255" href="#255">255</a>     <em>/**<em>*</em></em>
<a name="256" href="#256">256</a> <em>     * &lt;p></em>
<a name="257" href="#257">257</a> <em>     * &lt;code>parseText&lt;/code> parses the given text as an XML document and</em>
<a name="258" href="#258">258</a> <em>     * returns the newly created Document.</em>
<a name="259" href="#259">259</a> <em>     * &lt;/p></em>
<a name="260" href="#260">260</a> <em>     * </em>
<a name="261" href="#261">261</a> <em>     * @param text</em>
<a name="262" href="#262">262</a> <em>     *            the XML text to be parsed</em>
<a name="263" href="#263">263</a> <em>     * </em>
<a name="264" href="#264">264</a> <em>     * @return a newly parsed Document</em>
<a name="265" href="#265">265</a> <em>     * </em>
<a name="266" href="#266">266</a> <em>     * @throws DocumentException</em>
<a name="267" href="#267">267</a> <em>     *             if the document could not be parsed</em>
<a name="268" href="#268">268</a> <em>     */</em>
<a name="269" href="#269">269</a>     <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Document.html">Document</a> parseText(String text) throws DocumentException {
<a name="270" href="#270">270</a>         <a href="../../org/dom4j/Document.html">Document</a> result = <strong>null</strong>;
<a name="271" href="#271">271</a> 
<a name="272" href="#272">272</a>         <a href="../../org/dom4j/io/SAXReader.html">SAXReader</a> reader = <strong>new</strong> <a href="../../org/dom4j/io/SAXReader.html">SAXReader</a>();
<a name="273" href="#273">273</a>         String encoding = getEncoding(text);
<a name="274" href="#274">274</a> 
<a name="275" href="#275">275</a>         InputSource source = <strong>new</strong> InputSource(<strong>new</strong> StringReader(text));
<a name="276" href="#276">276</a>         source.setEncoding(encoding);
<a name="277" href="#277">277</a> 
<a name="278" href="#278">278</a>         result = reader.read(source);
<a name="279" href="#279">279</a> 
<a name="280" href="#280">280</a>         <em class="comment">// if the XML parser doesn't provide a way to retrieve the encoding,</em>
<a name="281" href="#281">281</a>         <em class="comment">// specify it manually</em>
<a name="282" href="#282">282</a>         <strong>if</strong> (result.getXMLEncoding() == <strong>null</strong>) {
<a name="283" href="#283">283</a>             result.setXMLEncoding(encoding);
<a name="284" href="#284">284</a>         }
<a name="285" href="#285">285</a> 
<a name="286" href="#286">286</a>         <strong>return</strong> result;
<a name="287" href="#287">287</a>     }
<a name="288" href="#288">288</a> 
<a name="289" href="#289">289</a>     <strong>private</strong> <strong>static</strong> String getEncoding(String text) {
<a name="290" href="#290">290</a>         String result = <strong>null</strong>;
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a>         String xml = text.trim();
<a name="293" href="#293">293</a> 
<a name="294" href="#294">294</a>         <strong>if</strong> (xml.startsWith(<span class="string">"&lt;?xml"</span>)) {
<a name="295" href="#295">295</a>             <strong>int</strong> end = xml.indexOf(<span class="string">"?>"</span>);
<a name="296" href="#296">296</a>             String sub = xml.substring(0, end);
<a name="297" href="#297">297</a>             StringTokenizer tokens = <strong>new</strong> StringTokenizer(sub, <span class="string">" =\&quot;\'"</span>);
<a name="298" href="#298">298</a> 
<a name="299" href="#299">299</a>             <strong>while</strong> (tokens.hasMoreTokens()) {
<a name="300" href="#300">300</a>                 String token = tokens.nextToken();
<a name="301" href="#301">301</a> 
<a name="302" href="#302">302</a>                 <strong>if</strong> (<span class="string">"encoding"</span>.equals(token)) {
<a name="303" href="#303">303</a>                     <strong>if</strong> (tokens.hasMoreTokens()) {
<a name="304" href="#304">304</a>                         result = tokens.nextToken();
<a name="305" href="#305">305</a>                     }
<a name="306" href="#306">306</a> 
<a name="307" href="#307">307</a>                     <strong>break</strong>;
<a name="308" href="#308">308</a>                 }
<a name="309" href="#309">309</a>             }
<a name="310" href="#310">310</a>         }
<a name="311" href="#311">311</a> 
<a name="312" href="#312">312</a>         <strong>return</strong> result;
<a name="313" href="#313">313</a>     }
<a name="314" href="#314">314</a> 
<a name="315" href="#315">315</a>     <em>/**<em>*</em></em>
<a name="316" href="#316">316</a> <em>     * &lt;p></em>
<a name="317" href="#317">317</a> <em>     * makeElement</em>
<a name="318" href="#318">318</a> <em>     * &lt;/p></em>
<a name="319" href="#319">319</a> <em>     * a helper method which navigates from the given Document or Element node</em>
<a name="320" href="#320">320</a> <em>     * to some Element using the path expression, creating any necessary</em>
<a name="321" href="#321">321</a> <em>     * elements along the way. For example the path &lt;code>a/b/c&lt;/code> would</em>
<a name="322" href="#322">322</a> <em>     * get the first child &amp;lt;a&amp;gt; element, which would be created if it did</em>
<a name="323" href="#323">323</a> <em>     * not exist, then the next child &amp;lt;b&amp;gt; and so on until finally a</em>
<a name="324" href="#324">324</a> <em>     * &amp;lt;c&amp;gt; element is returned.</em>
<a name="325" href="#325">325</a> <em>     * </em>
<a name="326" href="#326">326</a> <em>     * @param source</em>
<a name="327" href="#327">327</a> <em>     *            is the Element or Document to start navigating from</em>
<a name="328" href="#328">328</a> <em>     * @param path</em>
<a name="329" href="#329">329</a> <em>     *            is a simple path expression, seperated by '/' which denotes</em>
<a name="330" href="#330">330</a> <em>     *            the path from the source to the resulting element such as</em>
<a name="331" href="#331">331</a> <em>     *            a/b/c</em>
<a name="332" href="#332">332</a> <em>     * </em>
<a name="333" href="#333">333</a> <em>     * @return the first Element on the given path which either already existed</em>
<a name="334" href="#334">334</a> <em>     *         on the path or were created by this method.</em>
<a name="335" href="#335">335</a> <em>     */</em>
<a name="336" href="#336">336</a>     <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Element.html">Element</a> makeElement(<a href="../../org/dom4j/Branch.html">Branch</a> source, String path) {
<a name="337" href="#337">337</a>         StringTokenizer tokens = <strong>new</strong> StringTokenizer(path, <span class="string">"/"</span>);
<a name="338" href="#338">338</a>         <a href="../../org/dom4j/Element.html">Element</a> parent;
<a name="339" href="#339">339</a> 
<a name="340" href="#340">340</a>         <strong>if</strong> (source instanceof Document) {
<a name="341" href="#341">341</a>             <a href="../../org/dom4j/Document.html">Document</a> document = (Document) source;
<a name="342" href="#342">342</a>             parent = document.getRootElement();
<a name="343" href="#343">343</a> 
<a name="344" href="#344">344</a>             <em class="comment">// lets throw a NoSuchElementException</em>
<a name="345" href="#345">345</a>             <em class="comment">// if we are given an empty path</em>
<a name="346" href="#346">346</a>             String name = tokens.nextToken();
<a name="347" href="#347">347</a> 
<a name="348" href="#348">348</a>             <strong>if</strong> (parent == <strong>null</strong>) {
<a name="349" href="#349">349</a>                 parent = document.addElement(name);
<a name="350" href="#350">350</a>             }
<a name="351" href="#351">351</a>         } <strong>else</strong> {
<a name="352" href="#352">352</a>             parent = (Element) source;
<a name="353" href="#353">353</a>         }
<a name="354" href="#354">354</a> 
<a name="355" href="#355">355</a>         <a href="../../org/dom4j/Element.html">Element</a> element = <strong>null</strong>;
<a name="356" href="#356">356</a> 
<a name="357" href="#357">357</a>         <strong>while</strong> (tokens.hasMoreTokens()) {
<a name="358" href="#358">358</a>             String name = tokens.nextToken();
<a name="359" href="#359">359</a> 
<a name="360" href="#360">360</a>             <strong>if</strong> (name.indexOf(':') > 0) {
<a name="361" href="#361">361</a>                 element = parent.element(parent.getQName(name));
<a name="362" href="#362">362</a>             } <strong>else</strong> {
<a name="363" href="#363">363</a>                 element = parent.element(name);
<a name="364" href="#364">364</a>             }
<a name="365" href="#365">365</a> 
<a name="366" href="#366">366</a>             <strong>if</strong> (element == <strong>null</strong>) {
<a name="367" href="#367">367</a>                 element = parent.addElement(name);
<a name="368" href="#368">368</a>             }
<a name="369" href="#369">369</a> 
<a name="370" href="#370">370</a>             parent = element;
<a name="371" href="#371">371</a>         }
<a name="372" href="#372">372</a> 
<a name="373" href="#373">373</a>         <strong>return</strong> element;
<a name="374" href="#374">374</a>     }
<a name="375" href="#375">375</a> }
<a name="376" href="#376">376</a> 
<a name="377" href="#377">377</a> <em class="comment">/*</em>
<a name="378" href="#378">378</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="379" href="#379">379</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="380" href="#380">380</a> <em class="comment"> * following conditions are met:</em>
<a name="381" href="#381">381</a> <em class="comment"> * </em>
<a name="382" href="#382">382</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="383" href="#383">383</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="384" href="#384">384</a> <em class="comment"> * </em>
<a name="385" href="#385">385</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="386" href="#386">386</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="387" href="#387">387</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="388" href="#388">388</a> <em class="comment"> * </em>
<a name="389" href="#389">389</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="390" href="#390">390</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="391" href="#391">391</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="392" href="#392">392</a> <em class="comment"> * </em>
<a name="393" href="#393">393</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="394" href="#394">394</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="395" href="#395">395</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="396" href="#396">396</a> <em class="comment"> * </em>
<a name="397" href="#397">397</a> <em class="comment"> * 5. Due credit should be given to the DOM4J Project - <a href="http://www.dom4j.org" target="alexandria_uri">http://www.dom4j.org</a></em>
<a name="398" href="#398">398</a> <em class="comment"> * </em>
<a name="399" href="#399">399</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="400" href="#400">400</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="401" href="#401">401</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="402" href="#402">402</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="403" href="#403">403</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="404" href="#404">404</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="405" href="#405">405</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="406" href="#406">406</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="407" href="#407">407</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="408" href="#408">408</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="409" href="#409">409</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="410" href="#410">410</a> <em class="comment"> * </em>
<a name="411" href="#411">411</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="412" href="#412">412</a> <em class="comment"> */</em>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

